fix: sort header display names and avatars in a group chat view #28991

akinwale · 2023-10-06T09:30:13Z

Details

Follow-up to #28218. This adds additional checks to ensure that the sorted display names are displayed as a title ONLY for group chats.

A new method was added to the ReportUtils file, isGroupChat. The following conditions are taken into consideration to determine whether or not a report is a group chat.

The report is not a chat thread.
The report is not a task report.
The report is not a money request / IOU report.
The report is not an archived room.
The report is not a public / admin / announce chat room (chat type doesn't match any of the specified types).
The report has more than 2 participants.

Fixed Issues

$ #28048
PROPOSAL: #28048 (comment)

Tests

Launch Expensify
Create a group chat or open an existing group chat with at least 3 members
Verify that the display names in the header view are in the same order as the avatars in the chat view.
Verify that the display names in the LHN are in the same order as the avatars in the chat view.
In the LHN, verify that the room names are displayed for chat rooms (eg #admin, #announce) with more than 1 participant.
In the LHN, verify that the thread title is displayed for chat threads with more than 1 participant.
In the title view for any chat room with more than 1 participant, verify that the name of the chat room is displayed.
In the title view for any chat thread with more than 1 participant, verify that the thread title is correctly displayed.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

28048-web.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

28048-desktop.mp4

iOS

Android

melvin-bot · 2023-10-06T09:30:19Z

@allroundexperts Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

mountiny · 2023-10-06T10:41:54Z

src/components/LHNOptionsList/OptionRowLHN.js

+     *
+     * @returns {Boolean}
+     */
+    const isGroupChat = function () {


This does not seem ideal to me, i am going to check if there is a better way

This would mean we have to update this condition every time there might be a new chat report type

looking at this:

I think we could look at chatType === "" && optionItem.type === CONST.REPORT.TYPE.CHAT && !optionItem.isThread and participantAccountIDs.length > 2

Didn't realise chatType was available here too. Makes sense to use it.

I was initially wary of using participantAccountIDs.length > 2 because I thought it was possible to create a group chat with just 2 participants but discovered I was wrong after testing. This is perfect, thanks.

@akinwale I think we might be changing a lot about Group chats soon so this might change and yes then you can have a group chat with only one member. But that is not the case now

~~I still had to make use of the !optionItem.isMoneyRequestReport and !optionItem.isExpenseRequest checks in there as some tests fail without them.~~

Rechecking.

EDIT: False alert. They were failing because the tests were expecting 2 participants to be in sorted order, which is not the case anymore since it's only considered a group chat if there are 3 or more participants.

allroundexperts · 2023-10-09T16:46:38Z

@akinwale Conflicts!

akinwale · 2023-10-10T10:14:27Z

@allroundexperts This is ready for review. Thanks!

akinwale · 2023-10-12T10:02:56Z

@allroundexperts bump

allroundexperts · 2023-10-12T22:01:58Z

@akinwale Will get to this tomorrow.

akinwale · 2023-10-16T04:56:41Z

@allroundexperts Have you had a chance to look at this yet? Hoping to get this closed soon. Thanks.

allroundexperts · 2023-10-19T14:05:30Z

src/components/LHNOptionsList/OptionRowLHN.js

+        return optionItem.type === CONST.REPORT.TYPE.CHAT && _.isEmpty(optionItem.chatType) && !optionItem.isThread && lodashGet(optionItem, 'displayNamesWithTooltips.length', 0) > 2;
+    };
+
+    const fullTitle = isGroupChat() ? ReportUtils.getDisplayNamesStringFromTooltips(optionItem.displayNamesWithTooltips) : optionItem.text;


What's the advantage of making isGroupChat a function @akinwale?

It's just to make things clearer and more readable. There are 4 conditions being checked.

Yes, I get that, but can't you just save it in a variable instead?

ie

const isGroupChat = optionItem.type === CONST.REPORT.TYPE.CHAT && _.isEmpty(optionItem.chatType) && !optionItem.isThread && lodashGet(optionItem, 'displayNamesWithTooltips.length', 0) > 2; };

Oh, I suppose that works too! 😅

Will update.

allroundexperts · 2023-10-19T19:26:32Z

@akinwale Conflicts now!

akinwale · 2023-10-19T20:23:17Z

@allroundexperts Fixed.

allroundexperts · 2023-10-22T15:33:43Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

allroundexperts

Testing well!

Addressed

mountiny · 2023-10-23T12:02:24Z

All yours @stitesExpensify

stitesExpensify

Looks good, left a couple of questions

src/components/LHNOptionsList/OptionRowLHN.js

OSBotify · 2023-10-23T18:24:00Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-10-24T01:59:50Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.90-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-10-25T16:36:44Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.90-2 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-10-25T17:01:32Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.91-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-10-26T22:43:33Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

akinwale added 9 commits October 6, 2023 09:42

display sorted names for group chats in the header view and LHN

7306d5b

modify tests to handle display name sorting logic

9443ddc

use displayNamesWithTooltips list to set the sortedDisplayNames value

79a227e

use sorted display names as title in LHN only when the type is chat

9c52be7

use chain on personalDetailsList

74c0acc

assign full title value based on certain conditions

ab1ccb0

refactor shared code

c8165ff

cleanup fullTitle condition check

d749a37

add helper methods to determine if a report is a group chat

2b0f405

akinwale requested a review from a team as a code owner October 6, 2023 09:30

melvin-bot bot requested review from allroundexperts and removed request for a team October 6, 2023 09:30

akinwale mentioned this pull request Oct 6, 2023

[HOLD for payment 2023-11-01] [HOLD for payment 2023-10-13] [$500] Web - The order of avatars on the header sometimes matches the avatars on chat view #28048

Closed

6 tasks

mountiny previously requested changes Oct 6, 2023

View reviewed changes

akinwale added 2 commits October 9, 2023 17:58

fix merge conflicts

e9c4512

tweak conditions for checking for a group chat

5da2d3a

akinwale added 2 commits October 11, 2023 11:21

fix merge conflicts

21c9aee

fix lint

eadae89

akinwale mentioned this pull request Oct 11, 2023

[HOLD for payment 2023-10-25] [$250] Workspace - Display name for #announce room members in details page is cut off #29321

Closed

6 tasks

allroundexperts reviewed Oct 19, 2023

View reviewed changes

make isGroupChat a variable instead of a function

f46e365

akinwale requested a review from allroundexperts October 19, 2023 15:09

fix merge conflicts

b361613

mountiny assigned akinwale Oct 19, 2023

fix another merge conflict

e5662c3

allroundexperts approved these changes Oct 22, 2023

View reviewed changes

melvin-bot bot requested a review from stitesExpensify October 22, 2023 15:37

stitesExpensify requested changes Oct 23, 2023

View reviewed changes

src/components/LHNOptionsList/OptionRowLHN.js Show resolved Hide resolved

stitesExpensify approved these changes Oct 23, 2023

View reviewed changes

stitesExpensify merged commit 55f86ce into Expensify:main Oct 23, 2023
18 checks passed

OSBotify mentioned this pull request Oct 24, 2023

Deploy Checklist: New Expensify 2023-10-24 #30224

Closed

43 tasks

akinwale mentioned this pull request Oct 24, 2023

[CP Staging] fix: add chatType field to optionItem for identifying group chat reports #30273

Merged

59 tasks

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

akinwale mentioned this pull request Jan 5, 2024

[$500] When creating a group, members list does not show the account which created the group #33624

Closed

6 tasks

gijoe0295 mentioned this pull request Apr 2, 2024

[Pay 4/29][$500] Group chat - Share code subtitle does not include the group creator #39316

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: sort header display names and avatars in a group chat view #28991

fix: sort header display names and avatars in a group chat view #28991

akinwale commented Oct 6, 2023 •

edited

Loading

melvin-bot bot commented Oct 6, 2023

mountiny Oct 6, 2023

mountiny Oct 9, 2023

akinwale Oct 9, 2023

mountiny Oct 9, 2023

akinwale Oct 10, 2023 •

edited

Loading

allroundexperts commented Oct 9, 2023

akinwale commented Oct 10, 2023

akinwale commented Oct 12, 2023

allroundexperts commented Oct 12, 2023

akinwale commented Oct 16, 2023

allroundexperts Oct 19, 2023

akinwale Oct 19, 2023

allroundexperts Oct 19, 2023

allroundexperts Oct 19, 2023

akinwale Oct 19, 2023

akinwale Oct 19, 2023

allroundexperts commented Oct 19, 2023

akinwale commented Oct 19, 2023

allroundexperts commented Oct 22, 2023

allroundexperts left a comment

mountiny commented Oct 23, 2023

stitesExpensify left a comment

OSBotify commented Oct 23, 2023

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

fix: sort header display names and avatars in a group chat view #28991

fix: sort header display names and avatars in a group chat view #28991

Conversation

akinwale commented Oct 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akinwale Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

allroundexperts commented Oct 9, 2023

akinwale commented Oct 10, 2023

akinwale commented Oct 12, 2023

allroundexperts commented Oct 12, 2023

akinwale commented Oct 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allroundexperts commented Oct 19, 2023

akinwale commented Oct 19, 2023

allroundexperts commented Oct 22, 2023

Reviewer Checklist

Screenshots/Videos

allroundexperts left a comment

Choose a reason for hiding this comment

mountiny commented Oct 23, 2023

stitesExpensify left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 23, 2023

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

akinwale commented Oct 6, 2023 •

edited

Loading

akinwale Oct 10, 2023 •

edited

Loading